/*
 * *** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is part of dcm4che, an implementation of DICOM(TM) in
 * Java(TM), hosted at https://github.com/dcm4che.
 *
 * The Initial Developer of the Original Code is
 * J4Care.
 * Portions created by the Initial Developer are Copyright (C) 2013
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * See @authors listed below
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * *** END LICENSE BLOCK *****
 */

package org.dcm4chee.arc.query.scu;

import org.dcm4che3.data.Attributes;
import org.dcm4che3.data.AttributesCoercion;
import org.dcm4che3.data.IDWithIssuer;
import org.dcm4che3.net.ApplicationEntity;
import org.dcm4che3.net.Association;
import org.dcm4che3.net.DimseRSP;
import org.dcm4che3.net.QueryOption;
import org.dcm4chee.arc.MergeMWLQueryParam;
import org.dcm4chee.arc.conf.Duration;
import org.dcm4chee.arc.conf.MergeMWLMatchingKey;

import java.util.EnumSet;
import java.util.List;

/**
 * @author Gunter Zeilinger <gunterze@gmail.com>
 * @since May 2016
 */
public interface CFindSCU {
    List<Attributes> findPatient(ApplicationEntity localAE, String calledAET, int priority, IDWithIssuer pid,
                                 int... returnKeys) throws Exception;

    List<Attributes> findPatient(Association as, int priority, IDWithIssuer pid, int... returnKeys) throws Exception;

    List<Attributes> findStudiesOfPatient(ApplicationEntity localAE, String calledAET, int priority, IDWithIssuer pid,
                                 int... returnKeys) throws Exception;

    List<Attributes> find(ApplicationEntity localAE, String calledAET, EnumSet<QueryOption> queryOptions,
            int priority, Attributes keys) throws Exception;

    List<Attributes> findMWLItems(ApplicationEntity localAE, MergeMWLQueryParam queryParam, int priority)
            throws Exception;

    List<Attributes> findMWLItems(ApplicationEntity localAE, String calledAET, EnumSet<QueryOption> queryOptions,
            int priority, Attributes keys) throws Exception;

    List<Attributes> findStudy(ApplicationEntity localAE, String calledAET, int priority, String studyIUID,
                               int... returnKeys) throws Exception;

    List<Attributes> findStudiesByAccessionNumber(
            ApplicationEntity localAE, String calledAET, int priority, String accNo, int... returnKeys)
            throws Exception;

    List<Attributes> findStudy(Association as, int priority, String studyIUID, int... returnKeys) throws Exception;

    List<Attributes> findSeries(ApplicationEntity localAE, String calledAET, int priority, String studyIUID,
                                String seriesIUID, int... returnKeys) throws Exception;

    List<Attributes> findSeries(Association as, int priority, String studyIUID, String seriesIUID, int... returnKeys)
            throws Exception;

    List<Attributes> findInstance(ApplicationEntity localAE, String calledAET, int priority, String studyIUID,
                                  String seriesIUID, String sopIUID, int... returnKeys) throws Exception;

    List<Attributes> findInstance(Association as, int priority, String studyIUID, String seriesIUID, String sopIUID,
                                  int... returnKeys) throws Exception;

    Association openAssociation(
            ApplicationEntity localAE, String calledAET, String cuid, EnumSet<QueryOption> queryOptions)
            throws Exception;

    DimseRSP query(Association as, int priority, Attributes keys, int autocancel, int capacity, Duration splitStudyDateRange) throws Exception;

    Attributes coerceCFindRQ(Association as, Attributes keys);

    Attributes coerceCFindRSP(Association as, Attributes keys);
}
